fix(rtd): pin python to `<3.13` and mamba to `<2` #735

njzjz · 2024-10-07T19:38:39Z

Fix the RTD build error. Pinning mamba to <2 is a workaround for jupyterlite/xeus#122.

Summary by CodeRabbit

Chores
- Added a constraint specifying that the python dependency must be less than version 3.13.
- Updated the Python version in the Read the Docs configuration to mambaforge-23.11.

codecov · 2024-10-07T19:41:23Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.73%. Comparing base (b797acb) to head (496bf9d).
Report is 26 commits behind head on devel.

Additional details and impacted files

@@           Coverage Diff           @@
##            devel     #735   +/-   ##
=======================================
  Coverage   84.73%   84.73%           
=======================================
  Files          81       81           
  Lines        7345     7345           
=======================================
  Hits         6224     6224           
  Misses       1121     1121

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

codspeed-hq · 2024-10-07T19:41:27Z

CodSpeed Performance Report

Merging #735 will not alter performance

_{Comparing njzjz:rtd-debug (496bf9d) with devel (b797acb)}

Summary

✅ 2 untouched benchmarks

coderabbitai · 2024-10-07T19:41:45Z

📝 Walkthrough

Walkthrough

The changes involve modifications to the docs/rtd_environment.yml file, where the name field was updated from dpdata to dpdata-rtd, the mamba dependency was removed, and a constraint on the python dependency was added, specifying that it must be less than version 3.13. The .readthedocs.yaml configuration file was updated to change the specified version of Python from mambaforge-22.9 to mambaforge-23.11. Additionally, the docs/environment.yml file saw changes in the environment name from dpdata to dpdata-emscripten and the addition of a new channel for package installation.

Changes

File	Change Summary
docs/rtd_environment.yml	Updated `name` to `dpdata-rtd`; removed `mamba` dependency; added constraint on `python` (<3.13).
.readthedocs.yaml	Updated Python version from `mambaforge-22.9` to `mambaforge-23.11`.
docs/environment.yml	Updated environment name to `dpdata-emscripten`; added channel `https://repo.mamba.pm/emscripten-forge`.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant System
    User->>System: Request environment setup
    System->>System: Load docs/rtd_environment.yml
    System-->>User: Provide environment with updated name and python < 3.13

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 6f2c116 and 496bf9d.

📒 Files selected for processing (1)

docs/rtd_environment.yml (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

docs/rtd_environment.yml

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

This reverts commit 6f2c116.

This reverts commit e9be4e3.

debug RTD build

1482620

njzjz added 10 commits October 9, 2024 15:39

Merge branch 'devel' into rtd-debug

a60db98

python <3.13

f38dbd6

update mambaforge

667267c

update conda

7e88996

mamba

d343d55

rename env

e9be4e3

Update environment.yml

6f2c116

Revert "Update environment.yml"

0cecd92

This reverts commit 6f2c116.

Revert "rename env"

19bc618

This reverts commit e9be4e3.

pin mamba<2

496bf9d

njzjz changed the title ~~debug RTD build~~ fix(rtd): pin python to <3.13 and mamba to <2 Oct 11, 2024

njzjz marked this pull request as ready for review October 11, 2024 02:35

njzjz requested a review from wanghan-iapcm October 11, 2024 02:35

wanghan-iapcm approved these changes Oct 15, 2024

View reviewed changes

wanghan-iapcm merged commit 373e0d7 into deepmodeling:devel Oct 15, 2024
12 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(rtd): pin python to `<3.13` and mamba to `<2` #735

fix(rtd): pin python to `<3.13` and mamba to `<2` #735

njzjz commented Oct 7, 2024 •

edited

Loading

codecov bot commented Oct 7, 2024 •

edited

Loading

codspeed-hq bot commented Oct 7, 2024 •

edited

Loading

coderabbitai bot commented Oct 7, 2024 •

edited

Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

fix(rtd): pin python to <3.13 and mamba to <2 #735

fix(rtd): pin python to <3.13 and mamba to <2 #735

Conversation

njzjz commented Oct 7, 2024 • edited Loading

Summary by CodeRabbit

codecov bot commented Oct 7, 2024 • edited Loading

Codecov Report

codspeed-hq bot commented Oct 7, 2024 • edited Loading

CodSpeed Performance Report

Merging #735 will not alter performance

Summary

coderabbitai bot commented Oct 7, 2024 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

fix(rtd): pin python to `<3.13` and mamba to `<2` #735

fix(rtd): pin python to `<3.13` and mamba to `<2` #735

njzjz commented Oct 7, 2024 •

edited

Loading

codecov bot commented Oct 7, 2024 •

edited

Loading

codspeed-hq bot commented Oct 7, 2024 •

edited

Loading

coderabbitai bot commented Oct 7, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)